AI SDK Kotlin/ai.torad.aisdk/StreamEvent/StepFinish

StepFinish

@Serializable

data class StepFinish(val stepNumber: Int, val finishReason: FinishReason, val usage: Usage, val providerMetadata: Map<String, JsonElement>? = null) : StreamEvent

Step ended — aggregated finish reason + usage for that one step. Per historical parity gap #18 (slice), providerMetadata carries provider-specific payloads (Anthropic prompt-cache hints, OpenAI reasoning trace tokens, etc.) so consumers can measure cache-hit rate per step without parsing raw streams.

Constructors

constructor(stepNumber: Int, finishReason: FinishReason, usage: Usage, providerMetadata: Map<String, JsonElement>? = null)

Properties

val finishReason: FinishReason

val StreamEvent.metadata: Map<String, JsonElement>?

providerMetadata

val providerMetadata: Map<String, JsonElement>?

Optional provider-specific payload; null on providers that don't expose it. Mirrors v6's finishStep.providerMetadata.

val stepNumber: Int

val usage: Usage

Functions

providerMetadataAs

inline fun <T> StreamEvent.providerMetadataAs(provider: String): T?

fun <T> StreamEvent.providerMetadataAs(provider: String, serializer: KSerializer<T>): T?